Extract basic

The format of the basic output is described in the below table. The text for descriptions and long text is concatenated in the extract.

	Row Type	Column	Column Type	Purpose	Values
1		Row Type	string	The type of data on the row. HD=Header, RP=Response, RQ=Request, SC=Schema	HD, RP, RQ, SC
2	HD	Network scheme	string	Transport scheme/ Normally “http” or “https”	http, https, etc
3	HD	Host name	string	Name of the host which can be fully qualified domain name
4	HD	Route	string	Route outside of definition

2	RQ	Route	string	Route within the service specification
3	RQ	Text	string	Description of the route
4	RQ	Method	string
5	RQ	Https status code	string	Not applicable for requests	000
6	RQ		string	Description of the method and status segment
7	RQ	Field Seq	int	Sequence number of the field within segment
8	RQ	Field name	string	Field name
9	RQ	Field type	string	The type of the field or object. Objects are referred to by their name.	string, integer, id, complete, etc
10	RQ	Field subtype	string		date-time, int64, boolean,
11	RQ	Minimum length	int	Minimum length of data
12	RQ	Maximum length	int	Maximum length of data. A value of -1 indicates no limits
13	RQ	Field text	string	Description of the data in the field

2	RP	Route	string	Route within the service specification
3	RP	Text	string	Description of the route
4	RP	Method	string
5	RP	Https status code	string	Response status code	200, 404, etc
6	RP		string	Description of the method and status segment
7	RP	Field Seq	int	Sequence number of the field within segment
8	RP	Field name	string	Field name
9	RP	Field type	string	The type of the field or object. Objects are referred to by their name. Arrays are prefixed with “[]”	string, integer, id, complete, etc
10	RP	Field subtype	string		date-time, int64, boolean,
11	RP	Minimum length	int	Minimum length of data
12	RP	Maximum length	int	Maximum length of data. A value of -1 indicates no limits
13	RP	Field text	string	Description of the data in the field

2	SC	Schema	string	Scheam name
3	SC	Text	string	Describes the schema
4	SC			empty
5	SC			empty
6	SC			empty
7	SC	Field Seq	int	Sequence number of the field within segment
8	SC	Field Name	string	Field name
9	SC	Field type	string	The type of the field or object. Objects are referred to by their name. Arrays are prefixed with “[]”	string, integer, id, complete, etc
10	SC	Field subtype	string		date-time, int64, boolean,
11	SC	Minimum length	int	Minimum length of data
12	SC	Maximum length	int	Maximum length of data. A value of -1 indicates no limits
13	SC	Field text	string	Description of the data in the field

Example

Executing the below code will display the basic information for the PetStore OpenAPI specification

qaskx-cli   definition extract --category basic --spec https://petstore3.swagger.io/api/v3/openapi.json

The output to console will be something like:

	      ______           ___           _______. __  ___ ___   ___ 
	     /  __  \         /   \         /       ||  |/  / \  \ /  / 
	    |  |  |  |       /  ^  \       |   (----`|  '  /   \  V  /  
	    |  |  |  |      /  /_\  \       \   \    |    <     >   <   
	    |  `--'  '--.  /  _____  \  .----)   |   |  .  \   /  .  \  
	     \_____\_____\/__/     \__\ |_______/    |__|\__\ /__/ \__\ 
																   															 
	
          qaskx-cli  - command line tool 
          version     - 0.0.5
          url         - https://docs.qaskx.one/qaskx-cli/
          copyright   - 2023 qaskx.one, usage license limited

HD			C:/Users/tom/AppData/Local/Temp/QASKX1026796306/openapifile.json
RP	/user/createWithList	Creates list of users with given input...	POST	200	Successful operation	1	username	string		0	-1	
RP	/user/createWithList	Creates list of users with given input...	POST	200	Successful operation	2	firstName	string		0	-1	
RP	/user/createWithList	Creates list of users with given input...	POST	200	Successful operation	3	lastName	string		0	-1	
RP	/user/createWithList	Creates list of users with given input...	POST	200	Successful operation	4	email	string		0	-1	
RP	/user/createWithList	Creates list of users with given input...	POST	200	Successful operation	5	password	string		0	-1	
RP	/user/createWithList	Creates list of users with given input...	POST	200	Successful operation	6	phone	string		0	-1	
RP	/user/createWithList	Creates list of users with given input...	POST	200	Successful operation	7	userStatus	integer	int32	0	-1	User Status
RP	/user/createWithList	Creates list of users with given input...	POST	200	Successful operation	8	id	integer	int64	0	-1	
RQ	/user	This can only be done by the logged in...	POST	000	Created user object	1	username	string		0	0	
RQ	/user	This can only be done by the logged in...	POST	000	Created user object	2	firstName	string		0	0	
RQ	/user	This can only be done by the logged in...	POST	000	Created user object	3	lastName	string		0	0	
RQ	/user	This can only be done by the logged in...	POST	000	Created user object	4	email	string		0	0	
RQ	/user	This can only be done by the logged in...	POST	000	Created user object	5	password	string		0	0	
RQ	/user	This can only be done by the logged in...	POST	000	Created user object	6	phone	string		0	0	
RQ	/user	This can only be done by the logged in...	POST	000	Created user object	7	userStatus	integer	int32	0	0	User Status
RQ	/user	This can only be done by the logged in...	POST	000	Created user object	8	id	integer	int64	0	0	
RP	/user	This can only be done by the logged in...	POST	default	successful operation	1	lastName	string		0	-1	
RP	/user	This can only be done by the logged in...	POST	default	successful operation	2	email	string		0	-1	
RP	/user	This can only be done by the logged in...	POST	default	successful operation	3	password	string		0	-1	
RP	/user	This can only be done by the logged in...	POST	default	successful operation	4	phone	string		0	-1	
RP	/user	This can only be done by the logged in...	POST	default	successful operation	5	userStatus	integer	int32	0	-1	User Status
RP	/user	This can only be done by the logged in...	POST	default	successful operation	6	id	integer	int64	0	-1	
RP	/user	This can only be done by the logged in...	POST	default	successful operation	7	username	string		0	-1	
RP	/user	This can only be done by the logged in...	POST	default	successful operation	8	firstName	string		0	-1	
RQ	/store/order	Place a new order in the store	POST	000		1	shipDate	string	date-time	0	0	
RQ	/store/order	Place a new order in the store	POST	000		2	status	string		0	0	Order Status
RQ	/store/order	Place a new order in the store	POST	000		3	complete	boolean		0	0	
RQ	/store/order	Place a new order in the store	POST	000		4	id	integer	int64	0	0	
RQ	/store/order	Place a new order in the store	POST	000		5	petId	integer	int64	0	0	
RQ	/store/order	Place a new order in the store	POST	000		6	quantity	integer	int32	0	0	
RP	/store/order	Place a new order in the store	POST	200	successful operation	1	complete	boolean		0	-1	
RP	/store/order	Place a new order in the store	POST	200	successful operation	2	id	integer	int64	0	-1	
RP	/store/order	Place a new order in the store	POST	200	successful operation	3	petId	integer	int64	0	-1	
RP	/store/order	Place a new order in the store	POST	200	successful operation	4	quantity	integer	int32	0	-1	
RP	/store/order	Place a new order in the store	POST	200	successful operation	5	shipDate	string	date-time	0	-1	
RP	/store/order	Place a new order in the store	POST	200	successful operation	6	status	string		0	-1	Order Status
RQ	/pet	Add a new pet to the store	POST	000	Create a new pet in the store	1	id	integer	int64	0	0	
RQ	/pet	Add a new pet to the store	POST	000	Create a new pet in the store	2	name	string		0	0	
RQ	/pet	Add a new pet to the store	POST	000	Create a new pet in the store	3	category	Category		0	0	
RQ	/pet	Add a new pet to the store	POST	000	Create a new pet in the store	4	photoUrls	[]string		0	0	
RQ	/pet	Add a new pet to the store	POST	000	Create a new pet in the store	5	tags	[]Tag		0	0	
RQ	/pet	Add a new pet to the store	POST	000	Create a new pet in the store	6	status	string		0	0	pet status in the store
RP	/pet	Add a new pet to the store	POST	200	Successful operation	1	id	integer	int64	0	-1	
RP	/pet	Add a new pet to the store	POST	200	Successful operation	2	name	string		0	-1	
RP	/pet	Add a new pet to the store	POST	200	Successful operation	3	category	Category		0	-1	
RP	/pet	Add a new pet to the store	POST	200	Successful operation	4	photoUrls	[]string		0	-1	
RP	/pet	Add a new pet to the store	POST	200	Successful operation	5	tags	[]Tag		0	-1	
RP	/pet	Add a new pet to the store	POST	200	Successful operation	6	status	string		0	-1	pet status in the store
RQ	/pet	Update an existing pet by Id	PUT	000	Update an existent pet in the store	1	id	integer	int64	0	0	
RQ	/pet	Update an existing pet by Id	PUT	000	Update an existent pet in the store	2	name	string		0	0	
RQ	/pet	Update an existing pet by Id	PUT	000	Update an existent pet in the store	3	category	Category		0	0	
RQ	/pet	Update an existing pet by Id	PUT	000	Update an existent pet in the store	4	photoUrls	[]string		0	0	
RQ	/pet	Update an existing pet by Id	PUT	000	Update an existent pet in the store	5	tags	[]Tag		0	0	
RQ	/pet	Update an existing pet by Id	PUT	000	Update an existent pet in the store	6	status	string		0	0	pet status in the store
RP	/pet	Update an existing pet by Id	PUT	200	Successful operation	1	id	integer	int64	0	-1	
RP	/pet	Update an existing pet by Id	PUT	200	Successful operation	2	name	string		0	-1	
RP	/pet	Update an existing pet by Id	PUT	200	Successful operation	3	category	Category		0	-1	
RP	/pet	Update an existing pet by Id	PUT	200	Successful operation	4	photoUrls	[]string		0	-1	
RP	/pet	Update an existing pet by Id	PUT	200	Successful operation	5	tags	[]Tag		0	-1	
RP	/pet	Update an existing pet by Id	PUT	200	Successful operation	6	status	string		0	-1	pet status in the store
RP	/user/{username}		GET	200	successful operation	1	username	string		0	-1	
RP	/user/{username}		GET	200	successful operation	2	firstName	string		0	-1	
RP	/user/{username}		GET	200	successful operation	3	lastName	string		0	-1	
RP	/user/{username}		GET	200	successful operation	4	email	string		0	-1	
RP	/user/{username}		GET	200	successful operation	5	password	string		0	-1	
RP	/user/{username}		GET	200	successful operation	6	phone	string		0	-1	
RP	/user/{username}		GET	200	successful operation	7	userStatus	integer	int32	0	-1	User Status
RP	/user/{username}		GET	200	successful operation	8	id	integer	int64	0	-1	
RQ	/user/{username}	This can only be done by the logged in...	PUT	000	Update an existent user in the store	1	username	string		0	0	
RQ	/user/{username}	This can only be done by the logged in...	PUT	000	Update an existent user in the store	2	firstName	string		0	0	
RQ	/user/{username}	This can only be done by the logged in...	PUT	000	Update an existent user in the store	3	lastName	string		0	0	
RQ	/user/{username}	This can only be done by the logged in...	PUT	000	Update an existent user in the store	4	email	string		0	0	
RQ	/user/{username}	This can only be done by the logged in...	PUT	000	Update an existent user in the store	5	password	string		0	0	
RQ	/user/{username}	This can only be done by the logged in...	PUT	000	Update an existent user in the store	6	phone	string		0	0	
RQ	/user/{username}	This can only be done by the logged in...	PUT	000	Update an existent user in the store	7	userStatus	integer	int32	0	0	User Status
RQ	/user/{username}	This can only be done by the logged in...	PUT	000	Update an existent user in the store	8	id	integer	int64	0	0	
RP	/store/order/{orderId}	For valid response try integer IDs wit...	GET	200	successful operation	1	id	integer	int64	0	-1	
RP	/store/order/{orderId}	For valid response try integer IDs wit...	GET	200	successful operation	2	petId	integer	int64	0	-1	
RP	/store/order/{orderId}	For valid response try integer IDs wit...	GET	200	successful operation	3	quantity	integer	int32	0	-1	
RP	/store/order/{orderId}	For valid response try integer IDs wit...	GET	200	successful operation	4	shipDate	string	date-time	0	-1	
RP	/store/order/{orderId}	For valid response try integer IDs wit...	GET	200	successful operation	5	status	string		0	-1	Order Status
RP	/store/order/{orderId}	For valid response try integer IDs wit...	GET	200	successful operation	6	complete	boolean		0	-1	
RP	/pet/{petId}/uploadImage		POST	200	successful operation	1	type	string		0	-1	
RP	/pet/{petId}/uploadImage		POST	200	successful operation	2	message	string		0	-1	
RP	/pet/{petId}/uploadImage		POST	200	successful operation	3	code	integer	int32	0	-1	
RP	/pet/{petId}	Returns a single pet	GET	200	successful operation	1	id	integer	int64	0	-1	
RP	/pet/{petId}	Returns a single pet	GET	200	successful operation	2	name	string		0	-1	
RP	/pet/{petId}	Returns a single pet	GET	200	successful operation	3	category	Category		0	-1	
RP	/pet/{petId}	Returns a single pet	GET	200	successful operation	4	photoUrls	[]string		0	-1	
RP	/pet/{petId}	Returns a single pet	GET	200	successful operation	5	tags	[]Tag		0	-1	
RP	/pet/{petId}	Returns a single pet	GET	200	successful operation	6	status	string		0	-1	pet status in the store
SC	Category					1	id	integer	int64	0	-1	
SC	Category					2	name	string		0	-1	
SC	Tag					1	name	string		0	-1	
SC	Tag					2	id	integer	int64	0	-1