Merge pull request #224 from abraham/copilot/fix-220

[WIP] Override createApp scopes

Author: abraham

dist/schema.json

@@ -5124,55 +5124,8 @@
                   },
                   "scopes": {
                     "type": "string",
-                    "description": "Space separated list of scopes. If none is provided, defaults to `read`. See [OAuth Scopes] for a list of possible scopes.",
-                    "enum": [
-                      "profile",
-                      "read",
-                      "write",
-                      "push",
-                      "follow",
-                      "admin:read",
-                      "admin:write",
-                      "read:accounts",
-                      "read:blocks",
-                      "read:bookmarks",
-                      "read:favourites",
-                      "read:filters",
-                      "read:follows",
-                      "read:lists",
-                      "read:mutes",
-                      "read:notifications",
-                      "read:search",
-                      "read:statuses",
-                      "write:accounts",
-                      "write:blocks",
-                      "write:bookmarks",
-                      "write:conversations",
-                      "write:favourites",
-                      "write:filters",
-                      "write:follows",
-                      "write:lists",
-                      "write:media",
-                      "write:mutes",
-                      "write:notifications",
-                      "write:reports",
-                      "write:statuses",
-                      "admin:read:accounts",
-                      "admin:read:reports",
-                      "admin:read:domain_allows",
-                      "admin:read:domain_blocks",
-                      "admin:read:ip_blocks",
-                      "admin:read:email_domain_blocks",
-                      "admin:read:canonical_email_blocks",
-                      "admin:write:accounts",
-                      "admin:write:reports",
-                      "admin:write:domain_allows",
-                      "admin:write:domain_blocks",
-                      "admin:write:ip_blocks",
-                      "admin:write:email_domain_blocks",
-                      "admin:write:canonical_email_blocks"
-                    ],
-                    "default": "read"
+                    "format": "scopes",
+                    "description": "Space separated list of scopes. If none is provided, defaults to `read`. See [OAuth Scopes] for a list of possible scopes."
                   },
                   "website": {
                     "type": "string",

src/__tests__/integration/create-app-scopes-override.test.ts

@@ -0,0 +1,43 @@
+import { MethodParser } from '../../parsers/MethodParser';
+import { EntityParser } from '../../parsers/EntityParser';
+import { OpenAPIGenerator } from '../../generators/OpenAPIGenerator';
+
+describe('CreateApp scopes override', () => {
+  test('should override scopes property to use format scopes without enum for createApp operation', () => {
+    const methodParser = new MethodParser();
+    const entityParser = new EntityParser();
+
+    const entities = entityParser.parseAllEntities();
+    const methodFiles = methodParser.parseAllMethods();
+
+    const generator = new OpenAPIGenerator();
+    const spec = generator.generateSchema(entities, methodFiles);
+
+    // Find the createApp operation (POST /api/v1/apps)
+    const appsPath = spec.paths['/api/v1/apps'];
+    expect(appsPath).toBeDefined();
+    expect(appsPath.post).toBeDefined();
+
+    // Check the request body schema
+    const requestBody = appsPath.post!.requestBody as any;
+    expect(requestBody).toBeDefined();
+    expect(requestBody.content).toBeDefined();
+    expect(requestBody.content['application/json']).toBeDefined();
+
+    const schema = requestBody.content['application/json'].schema as any;
+    expect(schema).toBeDefined();
+    expect(schema.properties).toBeDefined();
+
+    // Verify scopes property has the correct format
+    const scopesProperty = schema.properties.scopes;
+    expect(scopesProperty).toBeDefined();
+    expect(scopesProperty.type).toBe('string');
+    expect(scopesProperty.format).toBe('scopes');
+
+    // Ensure it does NOT have enum values
+    expect(scopesProperty.enum).toBeUndefined();
+
+    // Verify the description is preserved
+    expect(scopesProperty.description).toContain('scopes');
+  });
+});

src/__tests__/integration/oauth-scopes-consolidation.test.ts

@@ -3,7 +3,7 @@ import { EntityParser } from '../../parsers/EntityParser';
 import { MethodParser } from '../../parsers/MethodParser';
 
 describe('OAuth Scopes Consolidation', () => {
-  test('should consolidate OAuth scopes across Application, CredentialApplication, and createApp', () => {
+  test('should consolidate OAuth scopes for Application and CredentialApplication, and override createApp scopes', () => {
     // Parse entities and methods
     const entityParser = new EntityParser();
     const entities = entityParser.parseAllEntities();
@@ -47,23 +47,16 @@ describe('OAuth Scopes Consolidation', () => {
       '#/components/schemas/OAuthScopes'
     );
 
-    // Check that createApp requestBody has OAuth scope enum (should be unchanged)
+    // Check that createApp requestBody uses format scopes (changed behavior)
     const createAppOperation = spec.paths['/api/v1/apps']?.post;
     expect(createAppOperation).toBeDefined();
 
     const requestBodySchema = createAppOperation!.requestBody?.content?.[
       'application/json'
     ]?.schema as any;
-    expect(requestBodySchema?.properties?.scopes?.enum).toBeDefined();
-    expect(requestBodySchema.properties.scopes.enum).toContain('read');
-    expect(requestBodySchema.properties.scopes.enum).toContain('write');
-    expect(requestBodySchema.properties.scopes.enum).toContain('profile');
-    expect(requestBodySchema.properties.scopes.enum.length).toBeGreaterThan(40);
-
-    // Verify that all three places have the same number of scopes
-    const oauthScopeCount = oauthScope.enum.length;
-    const createAppScopeCount = requestBodySchema.properties.scopes.enum.length;
-    expect(oauthScopeCount).toBe(createAppScopeCount);
+    expect(requestBodySchema?.properties?.scopes?.type).toBe('string');
+    expect(requestBodySchema?.properties?.scopes?.format).toBe('scopes');
+    expect(requestBodySchema?.properties?.scopes?.enum).toBeUndefined();
   });
 
   test('should maintain backwards compatibility for scope descriptions', () => {

src/generators/MethodConverter.ts

@@ -298,6 +298,15 @@ class MethodConverter {
             description: properties.redirect_uris.description,
           };
 
+          // Override scopes to use format scopes without enum values
+          if (properties.scopes) {
+            properties.scopes = {
+              type: 'string',
+              format: 'scopes',
+              description: properties.scopes.description,
+            };
+          }
+
           // Default behavior for createApp endpoint
           operation.requestBody = {
             description: 'JSON request body parameters',