New OpenAPI Spec

[connorwinston]

No description provided.

[netlify]

❌ Deploy Preview for directus-docs-v2 failed. Why did it fail? →

Name	Link
🔨 Latest commit	1ed52cb
🔍 Latest deploy log	https://app.netlify.com/sites/directus-docs-v2/deploys/67601c16fa01720008aa9db6

[bevis-hp]

@phazonoverload I have completed converting the json endpoints from the generated oas to the paths folder.
There were a few fully issues I came across stopping me 100% the task due to primarily name changes and changes from the old docs or these could not be issues.
If you answer these questions I can polish it off.

• GraphQL snippet for 'Update a comment' in old docs is delete_comment? I assume that's a mistake, What is the correct name?
• Is there getAsset SDK&GQL snippet?
• 'List Auth Providers' (oauth) has no GraphQL example, is that correct?
• Is there 'Authenticated using an OAuth provider' (oauthProvider) SDK&GQL snippet? Is it the old 'Login Using SSO Providers' snippet?
• Is there 'updateExtensionBundle' SDK&GQL snippet?
• Is 'createFile' the new verison of 'importFile' or 'uploadFile'?
• Is there a 'createOperations' can only find 'createOperation' in json? Old docs reference both, have included the snippets for the 'createOperations' as the requestBody suggests it takes an array.
• No Policies endpoints, cant find in the json?
• Is 'getMyPermissions' the new 'getUserPermissions'?
• 'schemaApply' doesn't have a generic request example, on a use example as is hard to make generic, what do you want to do here?
• Does 'updateLastUsedPageMe' need a SDK&GQL snipper, cant find any in old docs.
• Is 'Invite' under /user/invite/ the new 'registerUser' or the new 'inviteUser'? the request gives no hints to what SDK&GQL snippets needed.
• All of the utils rest enpoints have different names to the SDK and GQL, don't know if this is an issue.

[hola-soy-milk]

Thanks so much! I just left the below comment that's blocking me from a straightforward review. Could you please take a look?

[hola-soy-milk]

Just spoke about this with @phazonoverload, is it possible the other paths got removed or not added? Right now I'm only seeing permissions

[hola-soy-milk]

Thank you for adding these! I'm afraid I can't get the docs to run now.

Please can you take a look at my comment

[hola-soy-milk]

I'm afraid there's a : missing in this and the next few, giving me this error:

bundling ./api-spec/index.yaml...
Failed to parse API description at ./api-spec/index.yaml:

  - can not read an implicit mapping pair; a colon is missed in "/Users/carmenh/directus/docs/api-spec/index.yaml" (122:23)

 ELIFECYCLE  Command failed with exit code 1.
 ELIFECYCLE  Command failed with exit code 1.

Adding them then generates a bunch of errors:

[27] api-spec/paths/webhooks/_id/updateWebhook.yaml:53:5 at #/responses/404
                                                                                                                                                                  
Can't resolve $ref: ENOENT: no such file or directory '/Users/carmenh/directus/docs/api-spec/paths/components/responses.yaml'
                                                                                                                                                                  
51 |     $ref: ../../components/responses.yaml#/UnauthorizedError
52 |   '404':
53 |     $ref: ../../components/responses.yaml#/NotFoundError
54 | tags:
55 | - Webhooks
                                                                                                                                                                  
Error was generated by the bundler rule.

[bevis-hp]

Apologies. Very silly of me. Added them now.

[netlify]

❌ Deploy Preview for directus-docs-rewrite failed. Why did it fail? →

Name	Link
🔨 Latest commit	1ed52cb
🔍 Latest deploy log	https://app.netlify.com/sites/directus-docs-rewrite/deploys/67601c16cf05500008433c2c

[hola-soy-milk]

Thank you so much for this!

I've left a number of wording and formatting suggestions that I'm happy to handle myself.

I've also left a number of questions/requests. There's a number of endpoints and code snippets missing from the current documentation.

On a broader note:

• Is it possible to embed vue components into this?
• There is an inconsistent use of an example directus URL and a directus_url variable in code snippets. Can we make this consistent?
• In a few request body breakdowns, we show this ANYOF type. What is it? Can we add an explanation to it? See screenshot below.
  Thanks in advance!

Handled