Skip to content

Support of readonly attributes #254

Open
@Xusifob

Description

@Xusifob

Currently, some fields of my API are marked as ReadOnly. This is not reflected in the created documentation :

Here is my Schema :

"apiKey": {
                "type": "object",
                "description": "",
                "deprecated": false,
                "properties": {
                    "name": {
                        "description": "The name of your API Key",
                        "example": "production",
                        "type": "string"
                    },
                    "apiKey": {
                        "readOnly": true,
                        "description": "The API Key",
                        "example": "UkD8U2TNWvz56g8z0XdhqQ8ATptBTLdoJI0WFL",
                        "type": "string"
                    },
                    "lastUsage": {
                        "readOnly": true,
                        "description": "The Date you used this API Key for the last time",
                        "example": "2023-07-22T02:00:46+00:00",
                        "type": "string",
                        "format": "date-time",
                        "nullable": true
                    },
                    "id": {
                        "readOnly": true,
                        "description": "The unique identifier of your entity",
                        "example": "1ee27e2e-b90b-61f0-80b9-c5b18a3c9c50",
                        "type": "string",
                        "format": "uuid",
                        "nullable": true
                    },
                    "createdDate": {
                        "readOnly": true,
                        "description": "The Date the entity has been created",
                        "example": "2023-07-22T02:00:46+00:00",
                        "type": "string",
                        "format": "date-time"
                    }
                }
            },

Here is the documentation :
image

And the editor on the left :

Uploading image.png…

I am new to this project, I am willing to spend some time trying to fix this issue, if someone can help me to start on how to contribute and where I could find the problematic code

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions