[api] Modify YAML schema so that Swagger Codegen PHP Client works

[zaliqarosli]

Brief summary of changes

• Have you updated related documentation?

This PR:

Fixes:

• remove '#/components/schemas/InstrumentData' because the Data object does not have any explicitly defined properties
• fixes the schema where things are incorrectly defined
• adds 'Other' Sex option now available on LORIS core

Changes:

• modifies $InstrumentShortName key in Instrument API to 'Data' so that the key is static (i don't think there's a need for it to be dynamic depending on the instrument - the key is just the instrument instance data)

Testing instructions (if applicable)

Link(s) to related issue(s)

• Resolves # (Reference the issue this fixes, if any.)

[xlecours]

@zaliqarosli Fixes should changes schema.yml but other changes needs to go in schema-v0.0.4-dev.yml (e.g.: $intrumentname --> Data)

[ridz1208]

@zaliqarosli after speaking to @driusan the only remaining issues on this PR is that the instrument.class.inc endpoint is being modified which impacts all API versions.

@xlecours could you instruct @zaliqarosli how to deal with that? I think we were creating a copy of the class and tagging it with the api version... is that it? like instrument-0.0.4.class.inc or something ?

[xlecours]

@zaliqarosli

1. there should be a switch on version in the endpoint handleGet function similar to https://github.com/aces/Loris/blob/main/modules/api/php/endpoints/candidate/visit/images.class.inc#L136-L149
2. We need a new "view" class instrument_0_0_4_dev.class.inc similar to visit_0_0_4_dev.class.inc

[xlecours]

@zaliqarosli While I was trying the schema-v0.0.4-dev.yml file in swagger editor, it complained about multiple entries in the components that are defined twice. Would you mind fixing these in this PR as well?
ex: VisitStage, InstrumentVisit, ...

I'll approve the PR in its current stage anyways.
Thanks

[zaliqarosli]

@xlecours i am getting these failed tests

There were 4 failures:

1) LorisApiInstrumentsTest::testPatchCandidatesCandidVisitInstrumentsInstrument
Failed asserting that 200 matches expected 204.

/app/raisinbread/test/api/LorisApiInstrumentsTest.php:120

2) LorisApiInstrumentsTest::testPutCandidatesCandidVisitInstrumentsInstrument
Failed asserting that 200 matches expected 204.

/app/raisinbread/test/api/LorisApiInstrumentsTest.php:147

3) LorisApiInstrumentsTest::testPatchCandidatesCandidVisitInstrumentsInstrumentDde
Failed asserting that 200 matches expected 204.

/app/raisinbread/test/api/LorisApiInstrumentsTest.php:370

4) LorisApiInstrumentsTest::testPutCandidatesCandidVisitInstrumentsInstrumentDde
Failed asserting that 200 matches expected 204.

/app/raisinbread/test/api/LorisApiInstrumentsTest.php:403

which I don't understand as the instrument endpoint is clearly returning 204 No Content, and I'm not sure where the 200 is coming from. do you have any ideas?

[zaliqarosli]

@ridz1208 @driusan @xlecours can/should this go to the release branch?

[xlecours]

@ridz1208 Do you mean 24.1 or the next release?
Adding specification for Other Sex value is a documentation fix that could be applied to 24.1 but changing the variable property name to fixed Data is a new feature.

[ridz1208]

I agree with @xlecours but isnt that the reason the API is versioned separately than LORIS? as long as its going to 0.0.4-dev it should be fine if it goes in 24.1 as far as I understand

[driusan]

@ridz1208 yes but this PR is changing 0.0.3

[driusan]

nm, just saw that it's only the "other" part going to 0.0.3.