Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

api-definition endpoint should also include type definitions #2223

Closed
hikalkan opened this issue Nov 20, 2019 · 2 comments
Closed

api-definition endpoint should also include type definitions #2223

hikalkan opened this issue Nov 20, 2019 · 2 comments
Assignees
Milestone

Comments

@hikalkan
Copy link
Member

hikalkan commented Nov 20, 2019

To be able to support client side type generation (see #2222).
It will be optional since it makes the api-definition JSON larger:
/api/abp/api-definition?includeTypes=true

Developed on the branch: https://github.com/abpframework/abp/tree/api-definition

@hikalkan hikalkan added this to the 1.2 milestone Nov 20, 2019
@hikalkan hikalkan self-assigned this Nov 20, 2019
@mehmet-erim
Copy link
Contributor

We need the requirement information of the type parameters. It may be fine to add the isRequired field like below:

"Volo.Abp.Identity.IdentityRoleDto": {
      "baseType": "Volo.Abp.Application.Dtos.EntityDto<System.Guid>",
       ...
      "properties": [
        {
          "name": "Name",
          "type": "System.String",
          "typeSimple": "string",
+         "isRequired": false
        },
        {
          "name": "IsDefault",
          "type": "System.Boolean",
          "typeSimple": "boolean",
+         "isRequired": true
        },
      ]
    },

@hikalkan

@hikalkan
Copy link
Member Author

hikalkan commented Mar 5, 2020

Moved to #2981

@hikalkan hikalkan closed this as completed Mar 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants