search

api-platform / api-doc-parser

Transforms a Hydra API doc in an intermediate representation that can be used for various tasks such as creating smart API clients, scaffolding code or building administration interfaces.
MIT License
104 stars 71 forks source link

list and create endpoints aren't correctly matched #130

Open Pherkel opened 1 year ago

Pherkel commented 1 year ago

Api Doc-parser version: 0.16.1

Description
Following the guidelines for creating the endpoint names, I am just getting the operations defined for the /.../users/{id] endpoint (e.g. get, put, delete). The operations that are defined for the .../users endpoint (get, post) are not detected by the doc parser.

Possible Solution
This fork takes care of these issues. While you can inject the customized doc-parser in the following way:

import { parseOpenApi3Documentation } from '@emdgroup-liquid/api-doc-parser';
import { ApiPlatformAdminDataProvider, openApiDataProvider } from '@api-platform/admin';

const customDataProvider: ApiPlatformAdminDataProvider = openApiDataProvider({
  ...
  apiDocumentationParser: parseOpenApi3Documentation,
});

const Admin = () => {
  return (
    <OpenApiAdmin
      ...
      dataProvider={customDataProvider} />
  );
};

It would be nice to integrate the changes into this main repo.